ModeratorControlsService

class ModeratorControlsService(blueJeansClient: BlueJeansClient, bjnScheduler: BjnScheduler)

This service is used to perform moderator-only actions as listed below:

  1. Mute/Unmute other participants

  2. Mute/Unmute everyone else in the meeting

  3. Remove a participant from the meeting

  4. Start/Stop recording

  5. End meeting after x seconds

  6. Spotlight a video participant

Constructors

Link copied to clipboard
fun ModeratorControlsService(blueJeansClient: BlueJeansClient, bjnScheduler: BjnScheduler)

Types

Link copied to clipboard
sealed class RecordingSpace

Provides for the recording space available.

Link copied to clipboard
sealed class RecordingState

Provides for recording state i.e. started or stopped.

Properties

Link copied to clipboard
val isModeratorControlsAvailable: ObservableValueWithOptional<Boolean>

Observable that provides for moderator controls are available or not
true -> if moderator
false -> if not a moderator
null -> meeting not started

Link copied to clipboard
val isRecordingFeatureAvailable: ObservableValueWithOptional<Boolean>

Observable that provides about recording feature is available for the meeting.
This will be true only if meeting is joined as moderator and the meeting supports the recording feature

Link copied to clipboard

Observable that provides current recordingState
RecordingState.Started -> recording on
RecordingState.Stopped -> recording off
null -> meeting not started

Functions

Link copied to clipboard

Checks recording usage for the user's account.
Be Advised: Calling checkSpaceAvailabilityForRecording as a participant instead of a moderator throws an exception stating Moderator controls are not available.

Link copied to clipboard
fun endMeetingForAllParticipants(timeInSeconds: Long = 0)

Ends the current meeting there by removing all the participants of the meeting, after a provided delay duration. Note that this will end the meeting for the moderator immediately. If you wish to just end the meeting for yourself without ending the meeting for everyone, use MeetingService endMeeting

Link copied to clipboard

Remove the given participant from the meeting

Link copied to clipboard

Sets audio mute state for all the participants

Link copied to clipboard

Sets audio mute for a participant

Link copied to clipboard

Sets video mute state for all the participants

Link copied to clipboard

Sets video mute for a participant

Link copied to clipboard

Turn spotlight for a meeting's video participant. This feature is also referred to as "moderator pinning"
Whenever a spotlight for a participant "X" is turned on by a moderator, people layout would be pushed to all the participants and the video of "X" will take the main stage irrespective of whoever is the dominant speaker. This can be used to spotlight self or any other video participant in the meeting. Spotlight is applicable only for video participants and not for audio only participants.

Link copied to clipboard

Start meeting recording.
This method makes the request to the server to start recording.
Recording link will be shared over the email associated with the user's account.
and is slightly time consuming, may take at most 10 seconds.

Link copied to clipboard

Stop recording.
Be Advised: Calling stopRecording before recordingState transitions to RecordingState.Started causes the call to be ignored.